Apple WWDC 1996/WWDC96_1996 (CD).toast/Technology Materials/MacOS 8 Resources/Developer Tools/Mac OS 8 Interfaces & Libraries/Interfaces/IDLIncludes/HIControls.idl

Text File | 1996-05-01 | 8KB | 381 lines

/*
     File:        HIControls.idl

     Contains:    IDL interface for the HIControls class

     Version:    Technology:    System 8.0
                 Release:    Universal Interfaces 3.0d3 on Copland DR1

     Copyright:    © 1995-1996 by Apple Computer, Inc.  All rights reserved.

     Bugs?:        If you find a problem with this file, send the file and version
                 information (from above) and the problem description to:

                     Internet:    [e-mail]
                     AppleLink:    APPLE.BUGS
*/



#ifndef __HICONTROLS_IDL__
#define __HICONTROLS_IDL__

#include <HIPanels.idl>
#include <HIControlTypes.idl>

interface HIControl : HIPanel
{
// ======================================================
// Public Methods
// ======================================================

// * Initializer *

    // Initialize controls value, minimum, and maximum
    OSStatus InitControl(    in RefLabel                identifier,
                            in HIWindow                window,
                            in Rect                    bounds,
                            in SInt32                value,
                            in SInt32                minimumValue,
                            in SInt32                maximumValue);

// * Accessors *

    // Set and get the controls value
    void SetValue(in SInt32    newValue);
    SInt32 GetValue();

    // Set and get the controls minimum value
    void SetMinimum(in SInt32    newMinimum);
    SInt32 GetMinimum();

    // Set and get the controls maximum value
    void SetMaximum(in SInt32    newMaximum);
    SInt32 GetMaximum();

// * Selection simulation *
    void SimulateSelection ();



    implementation
    {

        passthru C_h =    "#include <Types.h>"
                        "#include <HIObjectTypes.h>"
                        "#include <HIControlTypes.h>";

        passthru C_xh =    "#include <Types.h>"
                        "#include <HIObjectTypes.h>"
                        "#include <HIControlTypes.h>";

        releaseorder:            InitControl,
                                SetValue,
                                GetValue,
                                SetMinimum,
                                GetMinimum,
                                SetMaximum,
                                GetMaximum,
                                SimulateSelection,
                                reserved0,
                                reserved1;
    };
};

interface HIPushButton : HIControl
{
// ======================================================
// Public Methods
// ======================================================

// * Initializer *

    OSStatus InitPushButton(in RefLabel                            identifier,
                            in HIWindow                         window,
                            in Rect                             bounds);

    void SetAdornment (in HIAdornment adornment);
    HIAdornment GetAdornment ();

    implementation
    {

        releaseorder:        InitPushButton,
                            SetAdornment,
                            GetAdornment;
    };
};

interface HIBevelButton : HIControl
{
// ======================================================
// Public Methods
// ======================================================

// * Initializer *

    OSStatus InitBevelButton(    in RefLabel                            identifier,
                                in HIWindow                         window,
                                in Rect                             bounds,
                                in HIControlBehavior                behavior);

// * Behavior *

    void SetBehavior(in HIControlBehavior    newBehavior);
    HIControlBehavior GetBehavior();

    implementation
    {

        releaseorder:            InitBevelButton,
                                SetBehavior,
                                GetBehavior;
    };
};

interface HICheckBox : HIControl
{
// ======================================================
// Public Methods
// ======================================================

// * Initializer *

    OSStatus InitCheckBox(    in RefLabel                                identifier,
                            in HIWindow                             window,
                            in Rect                                 bounds);

    implementation
    {

        releaseorder:            InitCheckBox;
    };
};

interface HIRadioButton : HIControl
{
// ======================================================
// Public Methods
// ======================================================

// * Initializer *

    OSStatus InitRadioButton(    in RefLabel                                identifier,
                                in HIWindow                             window,
                                in Rect                                 bounds);

    implementation
    {

        releaseorder:            InitRadioButton;
    };
};

interface HIDisclosureTriangle : HIControl
{
// ======================================================
// Public Methods
// ======================================================

// * Initializer *

    OSStatus InitDisclosureTriangle(in RefLabel                identifier,
                                    in HIWindow             window,
                                    in Point                anchor);

// * Values *

    // Returns true if the triangle is disclosed, false otherwise
    boolean IsDisclosed();

    implementation
    {

        releaseorder:            InitDisclosureTriangle,
                                IsDisclosed;
    };
};

interface HIScrollBar : HIControl
{
// ======================================================
// Public Methods
// ======================================================

// * Initializer *

    OSStatus InitScrollBar(    in RefLabel                        identifier,
                            in HIWindow                     window,
                            in Rect                         bounds,
                            in SInt32                        value,
                            in SInt32                        minimumValue,
                            in SInt32                        maximumValue);

// * Deltas *

    void SetArrowDelta(in UInt32 delta);
    UInt32 GetArrowDelta();

    void SetPageDelta(in UInt32 delta);
    UInt32 GetPageDelta();

    implementation
    {

        releaseorder:            InitScrollBar,
                                SetArrowDelta,
                                GetArrowDelta,
                                SetPageDelta,
                                GetPageDelta;
    };
};

interface HISlider : HIControl
{
// ======================================================
// Public Methods
// ======================================================

// * Initializer *

    OSStatus InitSlider(in RefLabel                identifier,
                        in HIWindow                window,
                        in Rect                    bounds,
                        in SInt32                value,
                        in SInt32                minimumValue,
                        in SInt32                maximumValue);

    implementation
    {

        releaseorder:            InitSlider;
    };
};

interface HILittleArrows : HIControl
{
// ======================================================
// Public Methods
// ======================================================

// * Initializer *

    OSStatus InitLittleArrows(    in RefLabel                identifier,
                                in HIWindow                window,
                                in Point                anchor,
                                in SInt32                value,
                                in SInt32                minimumValue,
                                in SInt32                maximumValue);

// * Deltas

    void SetArrowDelta(in UInt32 delta);
    UInt32 GetArrowDelta();

    implementation
    {

        releaseorder:            InitLittleArrows,
                                SetArrowDelta,
                                GetArrowDelta;
    };
};

interface HIProgressIndicator : HIControl
{
// ======================================================
// Public Methods
// ======================================================

// * Initializer *

    OSStatus InitProgressIndicator(    in RefLabel                    identifier,
                                    in HIWindow                    window,
                                    in Rect                        bounds,
                                    in HIControlBehavior        behavior);

// * Behavior

    void SetBehavior(in HIControlBehavior    newBehavior);
    HIControlBehavior GetBehavior();

// * kHIIndeterminate indicator spin control *

    void SpinForward();
    void SpinBackward();

    implementation
    {

        releaseorder:            InitProgressIndicator,
                                SetBehavior,
                                GetBehavior,
                                SpinForward,
                                SpinBackward;
    };
};

interface HIMenu;

interface HIPopUpControl : HIControl
{

// ======================================================
// Public Methods
// ======================================================

// * Initializer *

    OSStatus InitPopUpControl(    in RefLabel                identifier,
                                in HIWindow                window,
                                in Rect                    bounds);

// * Menu access *

    void SetMenu(in HIMenu    menu);
    HIMenu GetMenu();

    implementation
    {

        releaseorder:    InitPopUpControl,
                        SetMenu,
                        GetMenu;
    };
};

interface HIPopUpButton : HIPopUpControl
{
// ======================================================
// Public Methods
// ======================================================

// * Initializer *

    OSStatus InitPopUpButton(    in RefLabel                identifier,
                                in HIWindow             window,
                                in Rect                 bounds);

// * Title width *

    void AutomaticallyCalculateTitleWidth();
    void ManuallySetTitleWidth();
    boolean IsTitleWidthAutomaticallyCalculated();

    void SetTitleWidth(in UInt16 titleWidth);
    UInt16 GetTitleWidth();

    implementation
    {

        releaseorder:    InitPopUpButton,
                        AutomaticallyCalculateTitleWidth,
                        ManuallySetTitleWidth,
                        IsTitleWidthAutomaticallyCalculated,
                        SetTitleWidth,
                        GetTitleWidth;
    };
};

#endif